ComboBox: Clarify documentation of get_active_iter
authorDaniel Boles <dboles@src.gnome.org>
Thu, 24 Aug 2017 11:46:47 +0000 (12:46 +0100)
committerDaniel Boles <dboles@src.gnome.org>
Thu, 24 Aug 2017 20:32:05 +0000 (21:32 +0100)
https://bugzilla.gnome.org/show_bug.cgi?id=618160

gtk/gtkcombobox.c

index 1ddbbe300c907e6f4dd65789984f5ec230bd82c6..474eb21da23dabda3a8a2e34928f82891ebbc5af 100644 (file)
@@ -2377,11 +2377,12 @@ gtk_combo_box_set_active_internal (GtkComboBox *combo_box,
 /**
  * gtk_combo_box_get_active_iter:
  * @combo_box: A #GtkComboBox
- * @iter: (out): The uninitialized #GtkTreeIter
+ * @iter: (out): A #GtkTreeIter
  *
- * Sets @iter to point to the current active item, if it exists.
+ * Sets @iter to point to the currently active item, if any item is active.
+ * Otherwise, @iter is left unchanged.
  *
- * Returns: %TRUE, if @iter was set
+ * Returns: %TRUE if @iter was set, %FALSE otherwise
  *
  * Since: 2.4
  */